feat: extend node types with description #2488

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Draft

DmitryAnansky wants to merge 10 commits into main from feat/extend-node-types-with-description

+1,219 −459

Contributor

DmitryAnansky commented Jan 6, 2026 •

edited

Loading

What/Why/How?

Extended NodeTypes with description and documentationLink properties.
This update is used in diagnostic onHover feature..

Reference

Testing

Screenshots (optional)

Check yourself

Code changed? - Tested with Redoc/Realm/Reunite (internal)
All new/updated code is covered by tests
New package installed? - Tested in different environments (browser/node)
Documentation update considered

Security

The security impact of the change has been considered
Code follows company security practices and guidelines

changeset-bot bot commented Jan 6, 2026 •

edited

Loading

🦋 Changeset detected

Latest commit: 0dfd872

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 3 packages

Name	Type
@redocly/openapi-core	Patch
@redocly/cli	Patch
@redocly/respect-core	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

Contributor

github-actions bot commented Jan 6, 2026 •

edited

Loading

Coverage Report

Status	Category	Percentage	Covered / Total
🔵	Lines	78.58% (🎯 78%)	6192 / 7879
🔵	Statements	78.01% (🎯 78%)	6398 / 8201
🔵	Functions	81.95% (🎯 81%)	1263 / 1541
🔵	Branches	70.42% (🎯 70%)	4248 / 6032

File Coverage

File	Stmts	Branches	Functions	Lines	Uncovered Lines
Changed Files
packages/core/src/types/arazzo.ts	100%	100%	100%	100%
packages/core/src/types/asyncapi2.ts	95.78%	50%	85.71%	95.78%	62-82, 515-517, 523, 531-533, 539
packages/core/src/types/index.ts	97.29%	92.85%	100%	97.29%	132
packages/core/src/types/oas3.ts	75.36%	31.81%	66.66%	75.36%	616, 623, 758-761, 821-845
packages/core/src/types/oas3_1.ts	51.16%	25%	75%	51.16%	161, 168, 177, 210, 229-281
packages/core/src/types/oas3_2.ts	55.55%	0%	0%	55.55%	70-157

Generated in workflow #8340 for commit 0dfd872 by the Vitest Coverage Report Action

Contributor

github-actions bot commented Jan 6, 2026 •

edited

Loading

CLI Version	Mean Time ± Std Dev (s)	Relative Performance (Lower is Faster)
cli-latest	3.434s ± 0.081s	▓ 1.02x
cli-next	3.367s ± 0.019s	▓ 1.00x (Fastest)

DmitryAnansky added the snapshot label

Contributor

github-actions bot commented Jan 6, 2026

📦 A new experimental 🧪 version v0.0.0-snapshot.1767713938 of Redocly CLI has been published for testing.

Install with NPM:

npm install @redocly/[email protected]
# or
npm install @redocly/[email protected]
# or
npm install @redocly/[email protected]

⚠️ Note: This is a development build and may contain unstable features.

DmitryAnansky added snapshot and removed snapshot labels

Contributor

github-actions bot commented Jan 6, 2026

📦 A new experimental 🧪 version v0.0.0-snapshot.1767727100 of Redocly CLI has been published for testing.

Install with NPM:

npm install @redocly/[email protected]
# or
npm install @redocly/[email protected]
# or
npm install @redocly/[email protected]

⚠️ Note: This is a development build and may contain unstable features.

DmitryAnansky added snapshot and removed snapshot labels

Contributor

github-actions bot commented Jan 7, 2026

📦 A new experimental 🧪 version v0.0.0-snapshot.1767780988 of Redocly CLI has been published for testing.

Install with NPM:

npm install @redocly/[email protected]
# or
npm install @redocly/[email protected]
# or
npm install @redocly/[email protected]

⚠️ Note: This is a development build and may contain unstable features.

DmitryAnansky added snapshot and removed snapshot labels

Contributor

github-actions bot commented Jan 7, 2026

📦 A new experimental 🧪 version v0.0.0-snapshot.1767801935 of Redocly CLI has been published for testing.

Install with NPM:

npm install @redocly/[email protected]
# or
npm install @redocly/[email protected]
# or
npm install @redocly/[email protected]

⚠️ Note: This is a development build and may contain unstable features.

DmitryAnansky added 6 commits

January 14, 2026 14:42


          feat: extend node types with description

4ccba13


          chore: testing child node description and docs link

c08c1ad


          chore: test listof description format

0e7747a


          chore: describe more properties

6a4914c


          chore: updating node types for oas 3.0

65681b6


          feat: add description and docs-links for oas3 and arazzo1

afaf83a

DmitryAnansky force-pushed the feat/extend-node-types-with-description branch from 12d161b to afaf83a Compare

January 14, 2026 12:42

DmitryAnansky removed the snapshot label

DmitryAnansky added 3 commits

January 14, 2026 14:47


          chore: update smoke tests snapshot

9d82708


          feat: add description and documentation links for oas 3.2

bbcb738


          chore: add changelog

53ec1ef

DmitryAnansky added the snapshot label

Contributor

github-actions bot commented Jan 14, 2026

📦 A new experimental 🧪 version v0.0.0-snapshot.1768409426 of Redocly CLI has been published for testing.

Install with NPM:

npm install @redocly/[email protected]
# or
npm install @redocly/[email protected]
# or
npm install @redocly/[email protected]

⚠️ Note: This is a development build and may contain unstable features.


          feat: update oas 3.1 and async2 node types

0dfd872

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels